<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qclcommandqueue.cpp -->
  <title>QCLCommandQueue Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/style.css" />
  <script src="scripts/jquery.js" type="text/javascript"></script>
  <script src="scripts/functions.js" type="text/javascript"></script>
  <script src="./scripts/superfish.js" type="text/javascript"></script>
  <link rel="stylesheet" type="text/css" href="style/superfish.css" />  <script src="./scripts/narrow.js" type="text/javascript"></script>
  <link rel="stylesheet" type="text/css" href="style/narrow.css" />
  <!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="150"><img src="images/qt-logo.png" align="left" border="0" />&nbsp;&nbsp;<img src="images/qtopencl-logo.png" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"> <a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="qtopencl-all-classes.html"><font color="#004faf">All Classes</font></a></td>
</table>              <li><a href="modules.html">Modules</a></li>              <li>QtCL</li>
              <li>QCLCommandQueue</li>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QCLCommandQueue Class Reference</h1>
<!-- $$$QCLCommandQueue-brief -->
<p>The QCLCommandQueue class represents an OpenCL command queue on a <a href="qclcontext.html">QCLContext</a>. <a href="#details">More...</a></p>
<!-- @@@QCLCommandQueue -->
<pre class="highlightedCode brush: cpp">    #include &lt;QCLCommandQueue&gt;</pre><p>This class was introduced in QtOpenCL 4.7.</p>
<ul>
<li><a href="qclcommandqueue-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#QCLCommandQueue">QCLCommandQueue</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#QCLCommandQueue-2">QCLCommandQueue</a></b> ( QCLContext * <i>context</i>, cl_command_queue <i>id</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#QCLCommandQueue-3">QCLCommandQueue</a></b> ( const QCLCommandQueue &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#dtor.QCLCommandQueue">~QCLCommandQueue</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCLContext * </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#context">context</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#isNull">isNull</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#isOutOfOrder">isOutOfOrder</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#isProfilingEnabled">isProfilingEnabled</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> cl_command_queue </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#queueId">queueId</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#operator-not-eq">operator!=</a></b> ( const QCLCommandQueue &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCLCommandQueue &amp; </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#operator-eq">operator=</a></b> ( const QCLCommandQueue &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qclcommandqueue.html#operator-eq-eq">operator==</a></b> ( const QCLCommandQueue &amp; <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QCLCommandQueue-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QCLCommandQueue class represents an OpenCL command queue on a <a href="qclcontext.html">QCLContext</a>.</p>
<p>QCLCommandQueue is just a handle to a command queue. Commands are added to the queue by calling methods on <a href="qclcontext.html">QCLContext</a>, <a href="qclbuffer.html">QCLBuffer</a>, <a href="qclimage2d.html">QCLImage2D</a>, <a href="qclkernel.html">QCLKernel</a>, etc. These methods use <a href="qclcontext.html#commandQueue">QCLContext::commandQueue</a>() as the command destination. <a href="qclcontext.html#setCommandQueue">QCLContext::setCommandQueue</a>() can be used to alter the destination queue.</p>
</div>
<!-- @@@QCLCommandQueue -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCLCommandQueue[overload1]$$$QCLCommandQueue -->
<h3 class="fn"><a name="QCLCommandQueue"></a>QCLCommandQueue::QCLCommandQueue ()</h3>
<p>Constructs a null OpenCL command queue object.</p>
<!-- @@@QCLCommandQueue -->
<!-- $$$QCLCommandQueue$$$QCLCommandQueueQCLContext*cl_command_queue -->
<h3 class="fn"><a name="QCLCommandQueue-2"></a>QCLCommandQueue::QCLCommandQueue ( <a href="qclcontext.html">QCLContext</a> * <i>context</i>, cl_command_queue <i>id</i> )</h3>
<p>Constructs an OpenCL command queue object based on the supplied native OpenCL <i>id</i>, and associates it with <i>context</i>. This class will take over ownership of <i>id</i> and release it in the destructor.</p>
<!-- @@@QCLCommandQueue -->
<!-- $$$QCLCommandQueue$$$QCLCommandQueueconstQCLCommandQueue& -->
<h3 class="fn"><a name="QCLCommandQueue-3"></a>QCLCommandQueue::QCLCommandQueue ( const QCLCommandQueue &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QCLCommandQueue -->
<!-- $$$~QCLCommandQueue[overload1]$$$~QCLCommandQueue -->
<h3 class="fn"><a name="dtor.QCLCommandQueue"></a>QCLCommandQueue::~QCLCommandQueue ()</h3>
<p>Releases this OpenCL command queue. If this object is the last reference, the queue will be destroyed.</p>
<!-- @@@~QCLCommandQueue -->
<!-- $$$context[overload1]$$$context -->
<h3 class="fn"><a name="context"></a><a href="qclcontext.html">QCLContext</a> * QCLCommandQueue::context () const</h3>
<p>Returns the OpenCL context that created this queue object.</p>
<!-- @@@context -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a>bool QCLCommandQueue::isNull () const</h3>
<p>Returns true if this OpenCL command queue is null.</p>
<!-- @@@isNull -->
<!-- $$$isOutOfOrder[overload1]$$$isOutOfOrder -->
<h3 class="fn"><a name="isOutOfOrder"></a>bool QCLCommandQueue::isOutOfOrder () const</h3>
<p>Returns true if this command queue executes commands out of order; otherwise false if commands are executed in order.</p>
<!-- @@@isOutOfOrder -->
<!-- $$$isProfilingEnabled[overload1]$$$isProfilingEnabled -->
<h3 class="fn"><a name="isProfilingEnabled"></a>bool QCLCommandQueue::isProfilingEnabled () const</h3>
<p>Returns true if this command queue will perform profiling on commands; false otherwise.</p>
<p>Profiling information is made available when a <a href="qclevent.html">QCLEvent</a> finishes execution.</p>
<p>See also <a href="qclevent.html#finishTime">QCLEvent::finishTime</a>().</p>
<!-- @@@isProfilingEnabled -->
<!-- $$$queueId[overload1]$$$queueId -->
<h3 class="fn"><a name="queueId"></a>cl_command_queue QCLCommandQueue::queueId () const</h3>
<p>Returns the native OpenCL command queue identifier for this object.</p>
<!-- @@@queueId -->
<!-- $$$operator!=[overload1]$$$operator!=constQCLCommandQueue& -->
<h3 class="fn"><a name="operator-not-eq"></a>bool QCLCommandQueue::operator!= ( const QCLCommandQueue &amp; <i>other</i> ) const</h3>
<p>Returns true if this OpenCL command queue is not the same as <i>other</i>; false otherwise.</p>
<p>See also <a href="qclcommandqueue.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQCLCommandQueue& -->
<h3 class="fn"><a name="operator-eq"></a>QCLCommandQueue &amp; QCLCommandQueue::operator= ( const QCLCommandQueue &amp; <i>other</i> )</h3>
<p>Assigns <i>other</i> to this object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQCLCommandQueue& -->
<h3 class="fn"><a name="operator-eq-eq"></a>bool QCLCommandQueue::operator== ( const QCLCommandQueue &amp; <i>other</i> ) const</h3>
<p>Returns true if this OpenCL command queue is the same as <i>other</i>; false otherwise.</p>
<p>See also <a href="qclcommandqueue.html#operator-not-eq">operator!=</a>().</p>
<!-- @@@operator== -->
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright &copy; 2010 Nokia Corporation</td>
<td align="right">QtOpenCL Documentation</td>
</tr></table></div></address>  <script src="scripts/functions.js" type="text/javascript"></script>
  <script type="text/javascript">
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-4457116-5']);
  _gaq.push(['_trackPageview']);
  (function() {
  var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  })();
  </script>
</body>
</html>
